List members

GET

/v1/members

const url = 'https://api.devsecure.io/v1/members?limit=50';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.devsecure.io/v1/members?limit=50' \
  --header 'Authorization: Bearer <token>'

Workspace members, including email addresses (members:read).

Authorizations

ApiKey
members:read
OAuth2
members:read

Parameters

Query Parameters

limit

Limit

Page size (1-200).

integer

default: 50 >= 1 <= 200

Page size (1-200).

cursor

Any of:

string
null

string

<= 1024 characters

Opaque cursor from the previous page.

Responses

200

OK.

application/json

MemberList

object

data

required

Data

Array<object>

Member

object

required

Workspace-specific member id.

string

name

Any of:

string
null

string

email

required

Email

string

role

required

Role

string

role_label

required

Role Label

string

is_owner

required

Is Owner

boolean

joined_at

Any of:

string
null

string

pagination

required

PageInfo

object

next_cursor

required

Any of:

string
null

string

has_more

required

Has More

boolean

Example

{
  "data": [
    {
      "id": "usr_9d8c7b6a5f4e3d2c1b0a9f8e",
      "name": "Ada Lovelace",
      "email": "ada@example.com",
      "role": "security_admin",
      "role_label": "Security Admin"
    }
  ]
}

Headers

X-Request-ID

string

Identifies the request; quote it to support.

X-RateLimit-Limit

integer

Requests allowed per window.

X-RateLimit-Remaining

integer

Requests left in the window.

X-RateLimit-Reset

integer

Seconds until the window resets.

X-Has-Next-Page

string

Allowed values: true false

Whether another page follows.

400

The request is not valid (validation_error, invalid_cursor).

application/json

ErrorEnvelope

object

error

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

request_id

required

Any of:

string
null

string

details

Any of:

Array<object>

ErrorDetail

object

field

Any of:

string
null

string

message

required

Message

string

Example

{
  "error": {
    "code": "validation_error",
    "message": "The request is not valid.",
    "request_id": "req_3f0c2a9d5b6e4f7a8c1d2e3f4a5b6c7d"
  }
}

Headers

X-Request-ID

string

Identifies the request; quote it to support.

401

Missing, unknown, expired or revoked credential (invalid_credentials).

application/json

ErrorEnvelope

object

error

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

request_id

required

Any of:

string
null

string

details

Any of:

Array<object>

ErrorDetail

object

field

Any of:

string
null

string

message

required

Message

string

Example

{
  "error": {
    "code": "invalid_credentials",
    "message": "The credential is missing, invalid, expired or revoked.",
    "request_id": "req_3f0c2a9d5b6e4f7a8c1d2e3f4a5b6c7d"
  }
}

Headers

X-Request-ID

string

Identifies the request; quote it to support.

403

The credential may not do this (insufficient_scope, permission_denied, plan_not_allowed, quota_exceeded, target_not_authorized).

application/json

ErrorEnvelope

object

error

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

request_id

required

Any of:

string
null

string

details

Any of:

Array<object>

ErrorDetail

object

field

Any of:

string
null

string

message

required

Message

string

Example

{
  "error": {
    "code": "insufficient_scope",
    "message": "The credential does not have the scope this operation needs.",
    "request_id": "req_3f0c2a9d5b6e4f7a8c1d2e3f4a5b6c7d"
  }
}

Headers

X-Request-ID

string

Identifies the request; quote it to support.

429

Too many requests (rate_limited).

application/json

ErrorEnvelope

object

error

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

request_id

required

Any of:

string
null

string

details

Any of:

Array<object>

ErrorDetail

object

field

Any of:

string
null

string

message

required

Message

string

Example

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Retry after the time in Retry-After.",
    "request_id": "req_3f0c2a9d5b6e4f7a8c1d2e3f4a5b6c7d"
  }
}

Headers

X-Request-ID

string

Identifies the request; quote it to support.

X-RateLimit-Limit

integer

Requests allowed per window.

X-RateLimit-Remaining

integer

Requests left in the window.

X-RateLimit-Reset

integer

Seconds until the window resets.

Retry-After

integer

Seconds to wait before retrying.

500

Unexpected error (internal_error). Quote the request id to support.

application/json

ErrorEnvelope

object

error

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

request_id

required

Any of:

string
null

string

details

Any of:

Array<object>

ErrorDetail

object

field

Any of:

string
null

string

message

required

Message

string

Example

{
  "error": {
    "code": "internal_error",
    "message": "Something went wrong on our side.",
    "request_id": "req_3f0c2a9d5b6e4f7a8c1d2e3f4a5b6c7d"
  }
}

Headers

X-Request-ID

string

Identifies the request; quote it to support.