List people

GET

/api/v1/person

const url = 'https://app.prefactorai.com/api/v1/person';
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://app.prefactorai.com/api/v1/person \
  --header 'Authorization: Bearer <token>'

Authorizations

authorization

Parameters

Query Parameters

idempotency_key

One of:

string
Null

Optional idempotency key for ensuring request idempotency

string

team_id

One of:

Team_Id
Null

Team_Id

A valid team ID

string

Example

013xrzp12g3nqk8ns6jadrqmpgrjkeny

sorting

Sort order; a field name, optionally prefixed with - for descending (e.g. -id). Supported fields: id, name, email.

string

Sort order; a field name, optionally prefixed with - for descending (e.g. -id). Supported fields: id, name, email.

pagination[offset]

integer

Zero-based offset of the first item to return.

pagination[page_size]

integer

>= 1 <= 100

Number of items to return per page (1-100).

Responses

200

Success

application/json

object

pagination

One of:

PaginationOutput
Null

PaginationOutput

Pagination information

object

item_count

The total number of items

integer

item_end

The index of the last item in the page (one-based)

integer

item_start

The index of the first item in the page (one-based)

integer

next_page_offset

One of:

integer
Null

The offset of the next page (null if last page)

integer

page_count

The total number of pages

integer

page_index

The index of the current page (one-based)

integer

page_offset

The offset of the first item in the page (zero-based)

integer

page_size

The number of items per page

integer

previous_page_offset

One of:

integer
Null

The offset of the previous page (null if first page)

integer

sorting

One of:

Sorting
Null

Sorting

Sorting information

object

direction

The direction to sort by

string

Allowed values: asc desc

field

The field to sort by (values depend on the type of list)

string

Allowed values: id status started_at finished_at email name external_identifier raised_at cleared_at severity last_activity_span_at

nulls

Where to place null values. auto leaves placement to the database default.

string

Allowed values: first last auto

status

string

Allowed values: success

summaries

Array<object>

Person_Summary

object

email

Person email address

string

Person_Id

A valid person ID

string

name

Person name

string

team_ids

Team IDs this person belongs to

Array<string>

title

One of:

string
Null

Optional job title

string

type

Type of resource (always ‘person’)

string

Allowed values: person

Example

{
  "pagination": {
    "item_count": 200,
    "item_end": 100,
    "item_start": 91,
    "next_page_offset": 110,
    "page_count": 20,
    "page_index": 10,
    "page_offset": 90,
    "page_size": 10,
    "previous_page_offset": 80
  },
  "sorting": null,
  "status": "success",
  "summaries": [
    {
      "email": "jane@example.com",
      "id": "013xrzp12g3nqk8ns6jadrqmpgrjkeny",
      "name": "Jane Doe",
      "team_ids": [
        "013xrzp12g3nqk8ns6jadrqmpgrjkeny"
      ],
      "title": "Engineer",
      "type": "person"
    }
  ]
}

default

Error

application/json

One of:

object
object

object

code

string

Allowed values: bad_request bad_authtoken not_authenticated not_permitted not_implemented unknown not_found unexpected_ref_type unexpected invalid_action alert_unknown alert_already_cleared invalid_value required_value idempotency_key_already_used

message

string

status

string

Allowed values: error

Example

{
  "code": "bad_request",
  "status": "error"
}