---
title: List profiles
slug: andrei/list-profiles
createdAt: 2026-10-05T10:36:01.732Z
---

{
  "id": "dEHVYqwEdQbFfavFh44u_",
  "type": "api-oas-v2",
  "data": {
    "method": "GET",
    "url": "https://api.detected.app/api/v2/public/profiles",
    "servers": [
      {
        "url": "https://api.detected.app/api/v2/public/profiles",
        "description": "Production"
      }
    ],
    "name": "List profiles",
    "description": "<p>Returns a list of profiles for your account. Use the query parameters to filter the results.</p>\n<p>This endpoint is paginated. Use the <code>page</code> parameter to request further pages. The <code>meta</code> and <code>links</code> objects in the response describe the current page and link to the others.</p>",
    "contentType": "application/json",
    "request": {
      "pathParameters": [],
      "headerParameters": [
        {
          "name": "accept",
          "type": "string",
          "kind": "optional",
          "description": "Generated from available response content types",
          "enum": [
            "application/json"
          ],
          "default": "application/json"
        }
      ],
      "queryParameters": [
        {
          "kind": "optional",
          "name": "order_by",
          "type": "string",
          "description": "<p>Direction to sort the results in: <code>asc</code> for ascending or <code>desc</code> for descending. Use it together with <code>sort_by</code>; it has no effect if <code>sort_by</code> is omitted. The default is <code>asc</code>.</p>",
          "enum": [
            "desc",
            "asc"
          ]
        },
        {
          "kind": "optional",
          "name": "sort_by",
          "type": "string",
          "description": "<p>The field to sort the results by. Use it together with <code>order_by</code> to choose the direction; if <code>order_by</code> is omitted, results are sorted in ascending order (<code>asc</code>). If <code>sort_by</code> is omitted, results are returned in no guaranteed order.</p>\n<p>Supported fields:</p>\n<ul>\n<li><code>id</code></li>\n<li><code>configuration_id</code></li>\n<li><code>review_status</code></li>\n<li><code>created_at</code></li>\n<li><code>updated_at</code></li>\n</ul>"
        },
        {
          "kind": "optional",
          "name": "page",
          "type": "string",
          "description": "<p>Page number of the results to return, starting from 1. The number of items per page is returned in <code>meta.per_page</code>.</p>"
        },
        {
          "kind": "optional",
          "name": "id",
          "type": "string",
          "description": "<p>Filter by profile UUID. If a match is found, only that profile is returned.</p>"
        },
        {
          "kind": "optional",
          "name": "entity_type",
          "type": "string",
          "description": "Filter by entity type.",
          "enum": [
            "company",
            "sole_trader",
            "partnership",
            "charity",
            "government_entity",
            "incorporated_syndicate",
            "company_syndicate",
            "syndicate",
            "association",
            "trust",
            "fund",
            "club",
            "individual",
            "joint_individual"
          ]
        },
        {
          "kind": "optional",
          "name": "review_status",
          "type": "string",
          "description": "Filter by review status.",
          "enum": [
            "Processed",
            "Needs Review",
            "Additional Info Required",
            "Approved",
            "Declined",
            "Archived"
          ]
        },
        {
          "kind": "optional",
          "name": "team_id",
          "type": "string",
          "description": "Filter by the ID of the team the profile is assigned to."
        },
        {
          "kind": "optional",
          "name": "assignee_id",
          "type": "string",
          "description": "Filter by the ID of the case management user the profile is assigned to."
        },
        {
          "kind": "optional",
          "name": "risk_id",
          "type": "string",
          "description": "Filter by the ID of the risk category assigned to the profile."
        },
        {
          "kind": "optional",
          "name": "customer_reference",
          "type": "string",
          "description": "Filter by customer reference."
        },
        {
          "kind": "optional",
          "name": "configuration_id",
          "type": "string",
          "description": "Filter by the ID of the configuration assigned to the profile."
        }
      ],
      "bodyDataParameters": [],
      "formDataParameters": [],
      "oAuthParameters": [
        {
          "id": "AccessToken",
          "name": "AccessToken",
          "kind": "optional",
          "type": "http",
          "description": "<p>The API uses OAuth 2.0. Request an access token from <code>POST /oauth/token</code> with the client ID and client secret of your integration client, and your account slug. Send the access token in the <code>Authorization</code> header of every request, in the format <code>Authorization: Bearer &#x3C;access_token></code>. The access token carries the scopes set on your integration client in the dashboard. Access tokens expire. When one expires, request a new one.</p>",
          "scheme": "bearer"
        }
      ],
      "cookieParameters": []
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "OK",
        "jsonExample": "",
        "isExpanded": true,
        "headers": [
          {
            "kind": "optional",
            "name": "X-RateLimit-Limit",
            "description": ""
          },
          {
            "kind": "optional",
            "name": "X-RateLimit-Remaining",
            "description": ""
          },
          {
            "kind": "optional",
            "name": "x-ratelimit-reset",
            "description": ""
          },
          {
            "kind": "optional",
            "name": "retry-after",
            "description": ""
          }
        ],
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "schema": [
              {
                "name": "data",
                "kind": "optional",
                "type": "array",
                "description": "List of profiles",
                "modelRef": "#/components/schemas/ProfileListResource",
                "customType": "ProfileListResource[]",
                "schema": [
                  {
                    "name": "id",
                    "kind": "required",
                    "type": "string",
                    "description": "Profile UUID."
                  },
                  {
                    "name": "entity_type",
                    "kind": "optional",
                    "type": "object",
                    "description": "Entity type information.",
                    "example": "",
                    "schema": [
                      {
                        "name": "id",
                        "kind": "optional",
                        "type": "integer",
                        "description": "Entity type ID."
                      },
                      {
                        "name": "type",
                        "kind": "optional",
                        "type": "string<company | sole_trader | partnership | charity | government_entity | incorporated_syndicate | company_syndicate | syndicate | association | trust | fund | club | individual | joint_individual>",
                        "description": "Entity type value.",
                        "enum": [
                          "company",
                          "sole_trader",
                          "partnership",
                          "charity",
                          "government_entity",
                          "incorporated_syndicate",
                          "company_syndicate",
                          "syndicate",
                          "association",
                          "trust",
                          "fund",
                          "club",
                          "individual",
                          "joint_individual"
                        ]
                      },
                      {
                        "name": "label",
                        "kind": "optional",
                        "type": "string",
                        "description": "Entity type label."
                      }
                    ]
                  },
                  {
                    "name": "customer_reference",
                    "kind": "required",
                    "type": "string",
                    "description": "Your unique reference for the profile."
                  },
                  {
                    "name": "company_name",
                    "kind": "optional",
                    "type": "string",
                    "description": "Name of the company."
                  },
                  {
                    "name": "risk",
                    "kind": "optional",
                    "type": "object",
                    "description": "<p>Risk category assigned to the profile, or <code>null</code> if there is none.</p>",
                    "example": "",
                    "schema": [
                      {
                        "name": "id",
                        "kind": "optional",
                        "type": "string",
                        "description": "Risk category ID."
                      },
                      {
                        "name": "label",
                        "kind": "optional",
                        "type": "string",
                        "description": "Label of the risk category."
                      },
                      {
                        "name": "category",
                        "kind": "optional",
                        "type": "string",
                        "description": "Category of the risk."
                      }
                    ]
                  },
                  {
                    "name": "team",
                    "kind": "optional",
                    "type": "object",
                    "description": "<p>Team the profile is assigned to, or <code>null</code> if there is none.</p>",
                    "example": "",
                    "schema": [
                      {
                        "name": "id",
                        "kind": "optional",
                        "type": "number",
                        "description": "Team ID."
                      },
                      {
                        "name": "label",
                        "kind": "optional",
                        "type": "string",
                        "description": "Label of the team."
                      }
                    ]
                  },
                  {
                    "name": "configuration",
                    "kind": "optional",
                    "type": "object",
                    "description": "<p>Configuration assigned to the profile, or <code>null</code> if there is none.</p>",
                    "example": "",
                    "schema": [
                      {
                        "name": "id",
                        "kind": "optional",
                        "type": "number",
                        "description": "Configuration ID."
                      },
                      {
                        "name": "name",
                        "kind": "optional",
                        "type": "string",
                        "description": "Name of the configuration."
                      }
                    ]
                  },
                  {
                    "name": "brand",
                    "kind": "optional",
                    "type": "object",
                    "description": "<p>Brand assigned to the profile, or <code>null</code> if there is none.</p>",
                    "example": "",
                    "schema": [
                      {
                        "name": "id",
                        "kind": "optional",
                        "type": "string",
                        "description": "Brand UUID."
                      },
                      {
                        "name": "name",
                        "kind": "optional",
                        "type": "string",
                        "description": "Brand name."
                      },
                      {
                        "name": "slug",
                        "kind": "optional",
                        "type": "string",
                        "description": "Brand slug."
                      }
                    ]
                  },
                  {
                    "name": "review_status",
                    "kind": "required",
                    "type": "string<Processed | Needs Review | Additional Info Required | Approved | Declined | Archived>",
                    "description": "Review status of the profile.",
                    "enum": [
                      "Processed",
                      "Needs Review",
                      "Additional Info Required",
                      "Approved",
                      "Declined",
                      "Archived"
                    ]
                  },
                  {
                    "name": "assignee",
                    "kind": "optional",
                    "type": "object",
                    "description": "<p>Case management user the profile is assigned to, or <code>null</code> if there is none.</p>",
                    "example": "",
                    "schema": [
                      {
                        "name": "id",
                        "kind": "optional",
                        "type": "string",
                        "description": "ID of the case management user."
                      },
                      {
                        "name": "name",
                        "kind": "optional",
                        "type": "string",
                        "description": "Name of the case management user."
                      }
                    ]
                  },
                  {
                    "name": "review_at",
                    "kind": "optional",
                    "type": "string",
                    "description": "Date the profile's current review period started. The next review falls a configured review period after this date."
                  },
                  {
                    "name": "updated_at",
                    "kind": "required",
                    "type": "string",
                    "description": "Date and time the profile was last updated."
                  },
                  {
                    "name": "created_at",
                    "kind": "required",
                    "type": "string",
                    "description": "Date and time the profile was created."
                  }
                ]
              },
              {
                "name": "links",
                "kind": "optional",
                "type": "object",
                "description": "",
                "modelRef": "#/components/schemas/LinksResource",
                "customType": "LinksResource",
                "schema": [
                  {
                    "name": "first",
                    "kind": "optional",
                    "type": "string",
                    "description": "URL of the first page of results."
                  },
                  {
                    "name": "last",
                    "kind": "optional",
                    "type": "string",
                    "description": "URL of the last page of results."
                  },
                  {
                    "name": "prev",
                    "kind": "optional",
                    "type": "string",
                    "description": "<p>URL of the previous page of results, or null if there is none.</p>"
                  },
                  {
                    "name": "next",
                    "kind": "optional",
                    "type": "string",
                    "description": "<p>URL of the next page of results, or null if there is none.</p>"
                  }
                ]
              },
              {
                "name": "meta",
                "kind": "optional",
                "type": "object",
                "description": "",
                "modelRef": "#/components/schemas/MetaResource",
                "customType": "MetaResource",
                "schema": [
                  {
                    "name": "current_page",
                    "kind": "optional",
                    "type": "number",
                    "description": "Number of the current page."
                  },
                  {
                    "name": "from",
                    "kind": "optional",
                    "type": "number",
                    "description": "<p>Position of the first item on this page, counted across all pages.</p>"
                  },
                  {
                    "name": "last_page",
                    "kind": "optional",
                    "type": "number",
                    "description": "Number of the last page."
                  },
                  {
                    "name": "links",
                    "kind": "optional",
                    "type": "array",
                    "description": "<p>Pagination links, including links to the previous and next pages.</p>",
                    "example": "",
                    "itemType": "object",
                    "customType": "object[]",
                    "schema": [
                      {
                        "name": "url",
                        "kind": "optional",
                        "type": "string",
                        "description": "<p>URL of the page, or <code>null</code> if there is no such page.</p>"
                      },
                      {
                        "name": "label",
                        "kind": "optional",
                        "type": "string",
                        "description": "<p>Text to display for the link, for example a page number or \"Previous\".</p>"
                      },
                      {
                        "name": "active",
                        "kind": "optional",
                        "type": "boolean",
                        "description": "Whether this link is for the current page."
                      }
                    ]
                  },
                  {
                    "name": "path",
                    "kind": "optional",
                    "type": "string",
                    "description": "<p>Base URL of the endpoint, without query parameters.</p>"
                  },
                  {
                    "name": "per_page",
                    "kind": "optional",
                    "type": "number",
                    "description": "Number of items per page."
                  },
                  {
                    "name": "to",
                    "kind": "optional",
                    "type": "number",
                    "description": "<p>Position of the last item on this page, counted across all pages.</p>"
                  },
                  {
                    "name": "total",
                    "kind": "optional",
                    "type": "number",
                    "description": "Total number of items across all pages."
                  }
                ]
              }
            ],
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "401",
        "description": "<p>Unauthorized. The access token is missing, invalid or has expired.</p>",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "schema": [
              {
                "name": "message",
                "kind": "optional",
                "type": "string",
                "description": "<p>A human-readable description of the error.</p>"
              }
            ],
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "422",
        "description": "Unprocessable Content. The request was understood but failed validation. The response lists the fields that failed and why.",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "schema": [
              {
                "name": "message",
                "kind": "optional",
                "type": "string",
                "description": "<p>A human-readable description of the error.</p>"
              },
              {
                "name": "example_field",
                "kind": "optional",
                "type": "array",
                "description": "<p>Validation errors for one field of the request body. The property name is the name of the field that failed validation (<code>example_field</code> is a placeholder).</p>",
                "example": "",
                "itemType": "string",
                "customType": "string[]",
                "itemExample": "",
                "itemDefault": ""
              }
            ],
            "isExpanded": true
          }
        ]
      },
      {
        "statusCode": "429",
        "description": "<p>Too Many Requests. You have exceeded the rate limit. Wait for the number of seconds given in the <code>Retry-After</code> header before trying again.</p>",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "",
            "schema": [
              {
                "name": "message",
                "kind": "optional",
                "type": "string",
                "description": "<p>A human-readable description of the error.</p>"
              }
            ],
            "isExpanded": true
          }
        ]
      }
    ],
    "hasXCodeSamples": false,
    "examples": {
      "languages": [
        {
          "id": "example-0-curl",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request GET \\\n     --url https://api.detected.app/api/v2/public/profiles \\\n     --header 'accept: application/json'"
        },
        {
          "id": "example-1-javascript",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n   method: 'GET',\n   headers: myHeaders,\n   redirect: 'follow'\n};\n\nfetch(\"https://api.detected.app/api/v2/public/profiles\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "example-2-ruby",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.detected.app/api/v2/public/profiles\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n"
        },
        {
          "id": "example-3-python",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"https://api.detected.app/api/v2/public/profiles\"\n\npayload = {}\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "example-0-curl"
    },
    "results": {
      "languages": [
        {
          "id": "response-0-200",
          "language": "200",
          "code": "// OK\n{\n  \"data\": [\n    {\n      \"id\": \"\",\n      \"entity_type\": {\n        \"id\": 0,\n        \"type\": \"\",\n        \"label\": \"\"\n      },\n      \"customer_reference\": \"\",\n      \"company_name\": \"\",\n      \"risk\": {\n        \"id\": \"\",\n        \"label\": \"\",\n        \"category\": \"\"\n      },\n      \"team\": {\n        \"id\": 0,\n        \"label\": \"\"\n      },\n      \"configuration\": {\n        \"id\": 0,\n        \"name\": \"\"\n      },\n      \"brand\": {\n        \"id\": \"\",\n        \"name\": \"\",\n        \"slug\": \"\"\n      },\n      \"review_status\": \"\",\n      \"assignee\": {\n        \"id\": \"\",\n        \"name\": \"\"\n      },\n      \"review_at\": \"\",\n      \"updated_at\": \"\",\n      \"created_at\": \"\"\n    }\n  ],\n  \"links\": {\n    \"first\": \"\",\n    \"last\": \"\",\n    \"prev\": \"\",\n    \"next\": \"\"\n  },\n  \"meta\": {\n    \"current_page\": 0,\n    \"from\": 0,\n    \"last_page\": 0,\n    \"links\": [\n      {\n        \"url\": \"\",\n        \"label\": \"\",\n        \"active\": false\n      }\n    ],\n    \"path\": \"\",\n    \"per_page\": 0,\n    \"to\": 0,\n    \"total\": 0\n  }\n}"
        },
        {
          "id": "response-1-401",
          "language": "401",
          "code": "// Unauthorized. The access token is missing, invalid or has expired.\n{\n  \"message\": \"\"\n}"
        },
        {
          "id": "response-2-422",
          "language": "422",
          "code": "// Unprocessable Content. The request was understood but failed validation. The response lists the fields that failed and why.\n{\n  \"message\": \"\",\n  \"example_field\": [\n    \"\"\n  ]\n}"
        },
        {
          "id": "response-3-429",
          "language": "429",
          "code": "// Too Many Requests. You have exceeded the rate limit. Wait for the number of seconds given in the Retry-After header before trying again.\n{\n  \"message\": \"\"\n}"
        }
      ],
      "selectedLanguageId": "response-0-200"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}