---
id: get-profiles
sidebar_label: Get profiles
hide_title: true
hide_table_of_contents: true
api: {"operationId":"getProfiles","description":"Get profiles","tags":["Profiles"],"parameters":[{"name":"query","in":"query","description":"Allows for pagination and sorting using the deepObject notation.\n\n</br>\n\n`resource?query[limit]=50&query[offset]=0&query[order]=label`\n\n</br>\n\n<table><thead>\n<tr>\n<th>Parameter</th>\n<th>Description</th>\n<th>Default</th>\n</tr>\n</thead><tbody>\n<tr>\n<td>limit</td>\n<td>Limits the number of results returned</td>\n<td>100</td>\n</tr>\n<tr>\n<td>offset</td>\n<td>Returns the results starting at the value provided</td>\n<td>0</td>\n</tr>\n<tr>\n<td>order</td>\n<td>Allows you to determine the order in which the data is returned (not available on profile attributes)</td>\n<td>id</td>\n</tr>\n</tbody></table>\n","required":false,"schema":{"type":"object","properties":{"limit":{"type":"integer","description":"The limit of results to return","example":100},"offset":{"type":"integer","description":"The number of records to offset","example":50},"order":{"type":"string","description":"The attribute to order by","example":"created_at"}}},"style":"deepObject","explode":true,"example":"query[limit]=100&query[offset]=50&query[order]=created_at"},{"name":"exclude_attributes","in":"query","description":"Allows for optimization by not returning the associated attribute data for the returned profiles","required":false,"schema":{"type":"boolean","default":false},"example":true},{"name":"name","in":"query","description":"object name for filtering","required":false,"schema":{"type":"string"},"example":"objectname"},{"name":"profile_type_id","in":"query","description":"Profile Type ID for filtering","required":false,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},{"name":"status","in":"query","description":"status value for filtering","required":false,"schema":{"type":"string","enum":["Active","Inactive","On Leave","Terminated"]},"example":"Active"},{"name":"metadata","in":"query","description":"Returns batching metadata in the response","required":false,"example":true,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Expected response to a valid request","content":{"application/json":{"schema":{"type":"object","properties":{"profiles":{"type":"array","items":{"type":"object","properties":{"id":{"description":"the id","type":"string","format":"uuid","readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"uid":{"description":"the uid","type":"string","minLength":32,"maxLength":32,"readOnly":true,"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"name":{"description":"the name","type":"string","example":"my profile"},"profile_type_id":{"description":"The profile type id","type":"string","format":"uuid","example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"},"status":{"description":"the status","type":"string","enum":["Active","Inactive","On Leave","Terminated"],"example":"Active"},"id_proofing_status":{"description":"the id profing status","type":"string","enum":["pending","pass","fail"],"example":"pending"},"created_at":{"description":"the created at time","type":"string","format":"date-time","example":"2023-05-01T09:12:28Z"},"updated_at":{"description":"the updated at time","type":"string","format":"date-time","example":"2023-05-01T09:12:28Z"},"attributes":{"description":"the attributes","type":"object","additionalProperties":{"type":"string"},"example":{"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":{"type":"object","properties":{"limit":{"description":"The limit","type":"integer","format":"int32","example":50},"offset":{"description":"The offset","type":"integer","format":"int32","example":100},"total":{"description":"The total","type":"integer","format":"int32","example":10000},"next":{"description":"The link to the next page of data","type":"string","example":"/endpoint?limit=10&offset=60"},"previous":{"description":"The link to the previous page of data","type":"string","example":"/endpoint?limit=10&offset=40"}}}}}}}},"400":{"description":"Bad Request - unable to complete.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"error":{"example":"Invalid JSON syntax. Please check your syntax and try again."}}},{"type":"object","properties":{"error":{"example":"The <object> failed to create/update"},"errors":{"example":{"attribute":"can't be blank"}}}}]}}}},"500":{"description":"Internal Server Error - returned on unhandled exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"description":"A message describing the error","example":"Sorry something went wrong"}}}}}}},"method":"get","path":"/profiles","info":{"version":"1.0.0","title":"NERM Lifecycle API","description":"The Lifecycle API can be used to access and modify various resources in your environment.","license":{"name":"MIT"}},"postman":{"name":"Get profiles","description":{"content":"Get profiles","type":"text/plain"},"url":{"path":["profiles"],"host":["{{baseUrl}}"],"query":[{"disabled":false,"description":{"content":"Allows for optimization by not returning the associated attribute data for the returned profiles","type":"text/plain"},"key":"exclude_attributes","value":""},{"disabled":false,"description":{"content":"object name for filtering","type":"text/plain"},"key":"name","value":""},{"disabled":false,"description":{"content":"Profile Type ID for filtering","type":"text/plain"},"key":"profile_type_id","value":""},{"disabled":false,"description":{"content":"status value for filtering","type":"text/plain"},"key":"status","value":""},{"disabled":false,"description":{"content":"Returns batching metadata in the response","type":"text/plain"},"key":"metadata","value":""}],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}}
sidebar_class_name: "get api-method"
info_path: nerm/api/nerm-lifecycle-api
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Get profiles' (get-profiles)"
---

import ApiTabs from "@theme/ApiTabs";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import TabItem from "@theme/TabItem";

## Get profiles



Get profiles

<details style={{"marginBottom":"1rem"}} data-collapsed={false} open={true}><summary style={{}}><strong>Query Parameters</strong></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"query","in":"query","description":"Allows for pagination and sorting using the deepObject notation.\n\n</br>\n\n`resource?query[limit]=50&query[offset]=0&query[order]=label`\n\n</br>\n\n<table><thead>\n<tr>\n<th>Parameter</th>\n<th>Description</th>\n<th>Default</th>\n</tr>\n</thead><tbody>\n<tr>\n<td>limit</td>\n<td>Limits the number of results returned</td>\n<td>100</td>\n</tr>\n<tr>\n<td>offset</td>\n<td>Returns the results starting at the value provided</td>\n<td>0</td>\n</tr>\n<tr>\n<td>order</td>\n<td>Allows you to determine the order in which the data is returned (not available on profile attributes)</td>\n<td>id</td>\n</tr>\n</tbody></table>\n","required":false,"schema":{"type":"object","properties":{"limit":{"type":"integer","description":"The limit of results to return","example":100},"offset":{"type":"integer","description":"The number of records to offset","example":50},"order":{"type":"string","description":"The attribute to order by","example":"created_at"}}},"style":"deepObject","explode":true,"example":"query[limit]=100&query[offset]=50&query[order]=created_at"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"exclude_attributes","in":"query","description":"Allows for optimization by not returning the associated attribute data for the returned profiles","required":false,"schema":{"type":"boolean","default":false},"example":true}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"name","in":"query","description":"object name for filtering","required":false,"schema":{"type":"string"},"example":"objectname"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"profile_type_id","in":"query","description":"Profile Type ID for filtering","required":false,"schema":{"type":"string","format":"uuid"},"example":"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"status","in":"query","description":"status value for filtering","required":false,"schema":{"type":"string","enum":["Active","Inactive","On Leave","Terminated"]},"example":"Active"}}></ParamsItem><ParamsItem className={"paramsItem"} param={{"name":"metadata","in":"query","description":"Returns batching metadata in the response","required":false,"example":true,"schema":{"type":"boolean","default":false}}}></ParamsItem></ul></div></details><div><ApiTabs><TabItem label={"200"} value={"200"}><div>

Expected response to a valid request

</div><div><MimeTabs schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>profiles</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} deprecated={undefined} schemaDescription={"the id"} schemaName={"uuid"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"uid"} required={false} deprecated={undefined} schemaDescription={"the uid"} schemaName={"string"} qualifierMessage={"**Possible values:** `>= 32 characters` and `<= 32 characters`"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} deprecated={undefined} schemaDescription={"the name"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"profile_type_id"} required={false} deprecated={undefined} schemaDescription={"The profile type id"} schemaName={"uuid"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"status"} required={false} deprecated={undefined} schemaDescription={"the status"} schemaName={"string"} qualifierMessage={"**Possible values:** [`Active`, `Inactive`, `On Leave`, `Terminated`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"id_proofing_status"} required={false} deprecated={undefined} schemaDescription={"the id profing status"} schemaName={"string"} qualifierMessage={"**Possible values:** [`pending`, `pass`, `fail`]"} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"created_at"} required={false} deprecated={undefined} schemaDescription={"the created at time"} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"updated_at"} required={false} deprecated={undefined} schemaDescription={"the updated at time"} schemaName={"date-time"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>attributes</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

the attributes

</div><li><div><code>property name*</code><span style={{"opacity":"0.6"}}> string</span></div></li></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>_metadata</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"limit"} required={false} deprecated={undefined} schemaDescription={"The limit"} schemaName={"int32"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"offset"} required={false} deprecated={undefined} schemaDescription={"The offset"} schemaName={"int32"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"total"} required={false} deprecated={undefined} schemaDescription={"The total"} schemaName={"int32"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"next"} required={false} deprecated={undefined} schemaDescription={"The link to the next page of data"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"previous"} required={false} deprecated={undefined} schemaDescription={"The link to the previous page of data"} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"profiles\": [\n    {\n      \"id\": \"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e\",\n      \"uid\": \"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e\",\n      \"name\": \"my profile\",\n      \"profile_type_id\": \"db6f8e8b-65c2-47d5-a0db-90bcc4e9df9e\",\n      \"status\": \"Active\",\n      \"id_proofing_status\": \"pending\",\n      \"created_at\": \"2023-05-01T09:12:28Z\",\n      \"updated_at\": \"2023-05-01T09:12:28Z\",\n      \"attributes\": {\n        \"text_attribute_uid\": \"static text\",\n        \"date_attribute_uid\": \"01/15/2020\",\n        \"profile_select_attribute_uid\": \"Profile Name\",\n        \"multiple_profile_select_attribute_uid\": \"Profile Name,Second Profile Name,Third Profile Name\",\n        \"contributor_select_attribute_uid\": \"User Name\",\n        \"multiple_contributor_select_attribute_uid\": \"User Name,Second User Name,Third User Name\"\n      }\n    }\n  ],\n  \"_metadata\": {\n    \"limit\": 50,\n    \"offset\": 100,\n    \"total\": 10000,\n    \"next\": \"/endpoint?limit=10&offset=60\",\n    \"previous\": \"/endpoint?limit=10&offset=40\"\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

Bad Request - unable to complete.

</div><div><MimeTabs schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><div><div><span className={"badge badge--info"}>oneOf</span><SchemaTabs><TabItem label={"MOD1"} value={"0-item-properties"}><SchemaItem collapsible={false} name={"error"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={""} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></TabItem><TabItem label={"MOD2"} value={"1-item-properties"}><SchemaItem collapsible={false} name={"error"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={""} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"errors"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={""} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></TabItem></SchemaTabs></div></div></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"Invalid JSON syntax. Please check your syntax and try again.\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"500"} value={"500"}><div>

Internal Server Error - returned on unhandled exceptions.

</div><div><MimeTabs schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"error"} required={false} deprecated={undefined} schemaDescription={"A message describing the error"} schemaName={""} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"error\": \"Sorry something went wrong\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div>