Docs
/
/
Contact supportLog inGet started
Overview
Authentication
Errors
Postman
Get startedLog inContact support
Platform
Integrations
In-app UI
API reference
CLI reference
Management API
Developer tools
Tutorials

Members mAPI reference

Complete reference documentation for the Members resource.

Members

#

Members are the users who have access to the Knock account.

Endpoints

GET/v1/members
GET/v1/members/{id}
DELETE/v1/members/{id}

List members

#

Returns a paginated list of members for the current account. Optionally filter by role.

Endpoint

GET/v1/members

Query parameters

role
string

Filter members by role. One of: owner, admin, member, production_only_member, billing, support.

email
string

Filter members by email address (exact match).

after
string

The cursor to fetch entries after.

before
string

The cursor to fetch entries before.

limit
integer

The number of entries to fetch per-page.

Returns

PaginatedMemberResponse

A paginated list of Member. Contains a list of entries and page information.

entries
Member[]

A list of entries.

created_at
string(date-time)
Required

The timestamp of when the member joined the account.

id
string(uuid)
Required

The unique identifier of the member.

role
enum(string)
Required

The member's role in the account.

owneradminmemberproduction_only_memberbillingsupport
updated_at
string(date-time)
Required

The timestamp of when the member was last updated.

user
MemberUser
Required

Information about a user within the Knock dashboard. Not to be confused with an external user (recipient) of a workflow.

avatar_url
string

The URL of the user's avatar image.

created_at
string(date-time)
Required

The timestamp of when the user was created.

email
string(email)
Required

The user's email address.

id
string(uuid)
Required

The user's unique identifier.

name
string

The user's display name.

updated_at
string(date-time)
Required

The timestamp of when the user was last updated.

page_info
PageInfo

The information about a paginated result.

after
string

The cursor to fetch entries after. Will only be present if there are more entries to fetch.

before
string

The cursor to fetch entries before. Will only be present if there are more entries to fetch before the current page.

page_size
integer

The number of entries to fetch per-page.

Get a member

#

Returns a single member by their ID.

Endpoint

GET/v1/members/{id}

Path parameters

id
string(uuid)

The ID of the member to retrieve.

Returns

Member

A member of the account.

created_at
string(date-time)

The timestamp of when the member joined the account.

id
string(uuid)

The unique identifier of the member.

role
enum(string)

The member's role in the account.

owneradminmemberproduction_only_memberbillingsupport
updated_at
string(date-time)

The timestamp of when the member was last updated.

user
MemberUser

Information about a user within the Knock dashboard. Not to be confused with an external user (recipient) of a workflow.

avatar_url
string

The URL of the user's avatar image.

created_at
string(date-time)

The timestamp of when the user was created.

email
string(email)

The user's email address.

id
string(uuid)

The user's unique identifier.

name
string

The user's display name.

updated_at
string(date-time)

The timestamp of when the user was last updated.

Remove a member

#

Removes a member from the account.

Endpoint

DELETE/v1/members/{id}

Path parameters

id
string(uuid)

The ID of the member to remove.

Returns

204 No Content

Member

#

A member of the account.

Attributes

created_at
string(date-time)

The timestamp of when the member joined the account.

id
string(uuid)

The unique identifier of the member.

role
enum(string)

The member's role in the account.

owneradminmemberproduction_only_memberbillingsupport
updated_at
string(date-time)

The timestamp of when the member was last updated.

user
MemberUser

Information about a user within the Knock dashboard. Not to be confused with an external user (recipient) of a workflow.

avatar_url
string

The URL of the user's avatar image.

created_at
string(date-time)

The timestamp of when the user was created.

email
string(email)

The user's email address.

id
string(uuid)

The user's unique identifier.

name
string

The user's display name.

updated_at
string(date-time)

The timestamp of when the user was last updated.

MemberUser

#

Information about a user within the Knock dashboard. Not to be confused with an external user (recipient) of a workflow.

Attributes

avatar_url
string

The URL of the user's avatar image.

created_at
string(date-time)

The timestamp of when the user was created.

email
string(email)

The user's email address.

id
string(uuid)

The user's unique identifier.

name
string

The user's display name.

updated_at
string(date-time)

The timestamp of when the user was last updated.

New chat