Skip to content
Developers
Get started
Early access: these pages are being written and reviewed. Facts in the header boxes come straight from the product.

List the users in your organization

GET
/api/v1/users
curl --request GET \
--url https://api.pitch2sale.com/api/v1/users \
--header 'Authorization: Bearer <token>'

Available to every member. Each user carries role: the display info (_id, name, is_system) of their role, or null if it cannot be resolved; the role’s permissions are never included.

The organization’s users

Media typeapplication/json
object
users
required
Array<object>
object
_id
required
string
role_id
required
string
role
required
Any of:
object
_id
required
string
name
required
string
is_system
required
boolean
key
additional properties
any
Examplegenerated
{
"users": [
{
"_id": "example",
"role_id": "example",
"role": {
"_id": "example",
"name": "example",
"is_system": true
}
}
]
}

Authentication required or token invalid

Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{
"error": "example",
"code": "example",
"message": "example",
"details": [
{
"field": "example",
"message": "example",
"code": "example"
}
]
}

Role permission or token scope missing; OAuth app tokens are not accepted on this route

Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{
"error": "example",
"code": "example",
"message": "example",
"details": [
{
"field": "example",
"message": "example",
"code": "example"
}
]
}

Rate limit exceeded

Media typeapplication/json
object
error
required
string
code
string
message
string
details
Array<object>
object
field
required
string
message
required
string
code
required
string
Examplegenerated
{
"error": "example",
"code": "example",
"message": "example",
"details": [
{
"field": "example",
"message": "example",
"code": "example"
}
]
}