Resources Enums Models Clients

Apidoc Reference Api 0.3.47

History | Watch
  • Contact: N/A
  • License: N/A

Resources

echo

Operations

Method and Path Description
GET /echoes
GET /echoes/arrays-only

group

Operations

Method and Path Description
GET /groups/:organization

member

Operations

Method and Path Description
POST /members
GET /members
GET /members/:organization
POST /members/:organization/members_bulk

organization

Operations

Method and Path Description
POST /organizations
GET /organizations
GET /organizations/:guid

user

Operations

Method and Path Description
POST /users
GET /users
GET /users/:age_group
POST /users/noop

Headers

No headers

Imports

No imports

Enums

age_group

Name Value Description
Youth Youth

under 18
Adult Adult

18 and over

Interfaces

No interfaces

Models

big

Example Json: Minimal | Full

Interfaces: None

A model with a lot of fields.

Field Type Required? Default Description
f1 string Yes -

f2 string Yes -

f3 string Yes -

f4 string Yes -

f5 string Yes -

f6 string Yes -

f7 string Yes -

f8 string Yes -

f9 string Yes -

f10 string Yes -

f11 string Yes -

f12 string Yes -

f13 string Yes -

f14 string Yes -

f15 string Yes -

f16 string Yes -

f17 string Yes -

f18 string Yes -

f19 string Yes -

f20 string Yes -

f21 string Yes -

echo

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
value string Yes -

error

Example Json: Minimal | Full

Interfaces: None

Models an API error.

Field Type Required? Default Description
code string Yes -

message string Yes -

group

Example Json: Minimal | Full

Interfaces: None

A group of users in an organization.

Field Type Required? Default Description
members [user] Yes -

member

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
guid uuid Yes -

organization organization Yes -

user user Yes -

role string Yes -

organization

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
guid uuid Yes -

name string Yes -

user

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
guid uuid Yes -

email string Yes -

active boolean Yes -

age_group age_group Yes -

tags map[string] No -

user_list

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
users [user] Yes -

Unions

No unions

Annotations

No annotations