Get profiles

Get profiles

Query Parameters

• query object

  Allows for pagination and sorting using the deepObject notation.

  
  

  resource?query[limit]=50&query[offset]=0&query[order]=label

  
  

  Parameter	Description	Default
  limit	Limits the number of results returned	100
  offset	Returns the results starting at the value provided	0
  order	Allows you to determine the order in which the data is returned (not available on profile attributes)	id

  Example: query[limit]=100&query[offset]=50&query[order]=created_at
• exclude_attributes boolean

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

  Example: true
• name string

  object name for filtering

  Example: objectname
• profile_type_id uuid

  Profile Type ID for filtering

  Example: db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e
• status string

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

  status value for filtering

  Example: Active
• metadata boolean

  Returns batching metadata in the response

  Example: true

Responses

• 200
• 400
• 500

---

Expected response to a valid request

application/json

• Schema
• Example (from schema)

---

Schema

• profiles object[]

  id uuid

  the id

  uid string

  Possible values: >= 32 characters and <= 32 characters

  the uid

  name string

  the name

  profile_type_id uuid

  The profile type id

  status string

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

  the status

  id_proofing_status string

  Possible values: [pending, pass, fail]

  the id profing status

  created_at date-time

  the created at time

  updated_at date-time

  the updated at time

  attributes object

  the attributes

  property name* string
• _metadata object

  limit int32

  The limit

  offset int32

  The offset

  total int32

  The total

  next string

  The link to the next page of data

  previous string

  The link to the previous page of data

{
  "profiles": [
    {
      "id": "db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e",
      "uid": "db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e",
      "name": "my profile",
      "profile_type_id": "db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e",
      "status": "Active",
      "id_proofing_status": "pending",
      "created_at": "2023-05-01T09:12:28Z",
      "updated_at": "2023-05-01T09:12:28Z",
      "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": 50,
    "offset": 100,
    "total": 10000,
    "next": "/endpoint?limit=10&offset=60",
    "previous": "/endpoint?limit=10&offset=40"
  }
}

Bad Request - unable to complete.

application/json

• Schema
• Example (from schema)

---

Schema

oneOf
• MOD1
• MOD2
---
error
error
errors

{
  "error": "Invalid JSON syntax. Please check your syntax and try again."
}

Internal Server Error - returned on unhandled exceptions.

application/json

• Schema
• Example (from schema)

---

Schema

• error

  A message describing the error

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

Loading...