Users

List users

List the people in your organization, newest first by default. A user's id is what a project's access.memberIds, a task's assigneeId, and a field of type user take.

get/users

Request

  • Base URL
    https://api.parley.so/v1
  • URL
    https://api.parley.so/v1/users
  • Auth
    HTTP bearer

Query parameters

searchstring

Case-insensitive. Every word must appear in the user's first name, last name, or email.

role'owner' | 'admin' | 'member' | 'parley'

Only users with this role.

sort'email' | '-email' | 'createdAt' | '-createdAt'

Sort order: a field name, prefixed with - for descending. Defaults to -createdAt.

cursorstring

Opaque cursor from nextCursor. Pass the same filters and sort. Omit for the first page.

limitinteger

Maximum number of items to return.

Response

OK

nextCursorstring nullable required

Cursor for the next page, or null on the last page.

Changes

No recorded changes to this operation across all 2 revisions of this API.