Get profiles

GET 
/profiles

Get profiles

Request

Query Parameters

query object

Allows for pagination and sorting.

exclude_attributes boolean

Allows for optimization by not returning the associated attribute data for the returned profiles

name string

object name for filtering

profile_type_id uuid

Profile Type ID for filtering

status string

Possible values: [Active, Inactive, On Leave, Terminated]

status value for filtering

metadata boolean

Returns batching metadata in the response

Responses

200

Expected response to a valid request

application/json

Schema

Schema

profiles object[]
Array [
id uuid
The objects ID
uid string
Possible values: >= 32 characters and <= 32 characters
The objects UID
name string
This is the name of the profile.
profile_type_id uuid
This is the ID of the profile type the profile belongs to
status string
Possible values: [Active, Inactive, On Leave, Terminated]
This is the status of the profile
id_proofing_status string
Possible values: [pending, pass, fail]
This is the ID proofing staus of the profile
created_at date-time
The date and time the profile was created
updated_at date-time
The date and time the profile was updated
attributes object
Attributes that belong to this profile.
property name* string
]
_metadata object
limit integer
offset integer
total integer
next string
previous string

Example (from schema)

{
  "profiles": [
    {
      "id": "33f072dd-13b4-41e1-8ea0-16f2a59b57c8",
      "uid": "profileUid",
      "name": "Profile Name",
      "profile_type_id": "33f072dd-13b4-41e1-8ea0-16f2a59b57c8",
      "status": "Active",
      "id_proofing_status": "pending",
      "created_at": "2023-11-21T14:23:54.256-05:00",
      "updated_at": "2023-11-21T14:23:54.256-05:00",
      "attributes": {
        "text_attribute_uid": "static text",
        "date_attribute_uid": "01/15/2020",
        "profile_select_attribute_uid": "Profile Name",
        "multiple_profile_select_attribute_uid": "Profile Name,Second Profile Name,Third Profile Name",
        "contributor_select_attribute_uid": "User Name",
        "multiple_contributor_select_attribute_uid": "User Name,Second User Name,Third User Name"
      }
    }
  ],
  "_metadata": {
    "limit": 0,
    "offset": 0,
    "total": 0,
    "next": "/endpoint?limit=10&offset=60",
    "previous": "/endpoint?limit=10&offset=40"
  }
}

400

Bad Request - unable to complete.

application/json

Schema

Schema

oneOf
InvalidJson
error
ValidationErrors
error
errors

Example (from schema)

{}

500

Internal Server Error - returned on unhandled exceptions.

application/json

Schema

Schema

error

A message describing the error

Example (from schema)

{
  "error": "Sorry something went wrong"
}

Loading...