Skip to content
Tallyraydocs

An account's members with their users: your own account's, or the account staff name; or a user's memberships (user_id)

GET
/v1/memberships
curl --request GET \
  --url 'https://example.com/v1/memberships?sort=created_at' \
  --header 'Authorization: Bearer <token>'

Who: a signed-in user, not an API key. Not for API keys.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
page_size
integer
>= 1

Rows a page, up to the list’s maximum; the service’s default when left out

page_token
string

The previous page’s meta.next_page_token

sort
string

Comma-separated fields, each with - for descending

account
string
user_id
string
status
string

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
data
required
Array<object>
object
account
required
object
id
integer format: int64
kind
required
string | null
Allowed values: network affiliate advertiser service workspace
account_name
required
string
created_at
required
string | null format: date-time
created_by
required
Any of:
object
account
string
id
string
kind
required
string | null
Allowed values: user api_key service system postback rule tuner schedule
name
string
id
string
owner
required
boolean
role
required
string | null
Allowed values: admin manager affiliate advertiser buyer viewer support
status
required
string | null
Allowed values: invited active
updated_at
required
string | null format: date-time
user
Any of:
object
created_at
required
string format: date-time
created_by
required
Any of:
object
account
string
id
string
kind
required
string | null
Allowed values: user api_key service system postback rule tuner schedule
name
string
email
required
string
email_verified_at
required
string | null format: date-time
id
required
string
last_signed_in_at
required
string | null format: date-time
name
required
string
status
required
string | null
Allowed values: invited unverified active disabled
time_zone
required
string
updated_at
required
string format: date-time
user_id
required
string
meta
required
object
next_page_token
required
string | null
total
required
integer | null format: int64
total_approximate
required
boolean

Example 

{
  "data": [
    {
      "account": {
        "kind": "network"
      },
      "created_by": {
        "kind": "user"
      },
      "role": "admin",
      "status": "invited",
      "user": {
        "created_by": {
          "kind": "user"
        },
        "status": "invited"
      }
    }
  ]
}

default

Section titled “default”

An error, as go-commons apperr maps it

Media typeapplication/json
object
error
required
object
code
required
string
fields
object
key
additional properties
string
message
required
string

Example generated

{
  "error": {
    "code": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "message": "example"
  }
}