Get users

GET /companies/{company_id}/users

Find users from a specific company.

Path parameters

  • company_id string Required

    The Company ID given by Fipto.

    Format should match the following pattern: [0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}.

Query parameters

  • page_number number

    The page number retrieved in the paginated results. The default value is 1.

  • page_size number

    The number of items to include in each page of the paginated results. The default value is 100.

  • sort string

    The sort field used to filter data.

    Values are created_at or email. Default value is created_at.

Responses

  • 200

    List of users.

    Hide response attributes Show response attributes object
    • meta object Required
      Hide meta attributes Show meta attributes object
      • request_id string Required

        Unique identifier generated by the server.

        Format should match the following pattern: [0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}.

      • query_parameters object

        Information about the parameters in the request. All query string parameters provided (or implicit/with default value) will be returned

    • data array[object] Required

      One of:
      company_user_api array[object] company_user_frontend array[object]
GET /companies/{company_id}/users 
curl \
 -X GET https://api.fipto.app/companies/9de0691c-bc8d-409b-8f40-75d4f45db2f3/users
Response examples (200) 
{
  "meta": {
    "request_id": "string",
    "query_parameters": {}
  },
  "data": [
    {
      "id": "string",
      "type": "user",
      "attributes": {
        "status": "active",
        "whitelisted_ips": [
          "string"
        ],
        "public_key": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAx5ENo5B+OJn92GpUn4qm\ni0m5c3scBfoowMLZlSa5q1lnaEfp7eiI1rNemcH8djt7d2T/YzWIsYywmwtzhQjw\nCxJtRFGGhTk6oFLgCGClwKi3SRODgZYyLGXgqKYstbODX5LDefY/SIqB4o7T3Asu\nd2aYu2pXmeiJYOsHf8S16e1+J2uDgsuPpLc+E4NGZTJ9KcqgV/PuOkqDlFpMSo5l\nTF/OBqRtcO8om2wILgPk8GvEqb7xjptwuqEkyvTZE+sKXDffPlwBqkhGLGEMe1vR\nnzBptA+DxeSIyxXPRYcAdHEWKKUu8gZeVrUl1QDsv68ubqruVfNrdtujMPrhPqcE\nVQIDAQAB\n-----END PUBLIC KEY-----\n",
        "name": "Johnny Nguyen"
      }
    }
  ]
}
Response examples (200) 
{
  "meta": {
    "request_id": "string",
    "query_parameters": {}
  },
  "data": [
    {
      "id": "string",
      "type": "user",
      "attributes": {
        "status": "active",
        "whitelisted_ips": [
          "string"
        ],
        "public_key": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAx5ENo5B+OJn92GpUn4qm\ni0m5c3scBfoowMLZlSa5q1lnaEfp7eiI1rNemcH8djt7d2T/YzWIsYywmwtzhQjw\nCxJtRFGGhTk6oFLgCGClwKi3SRODgZYyLGXgqKYstbODX5LDefY/SIqB4o7T3Asu\nd2aYu2pXmeiJYOsHf8S16e1+J2uDgsuPpLc+E4NGZTJ9KcqgV/PuOkqDlFpMSo5l\nTF/OBqRtcO8om2wILgPk8GvEqb7xjptwuqEkyvTZE+sKXDffPlwBqkhGLGEMe1vR\nnzBptA+DxeSIyxXPRYcAdHEWKKUu8gZeVrUl1QDsv68ubqruVfNrdtujMPrhPqcE\nVQIDAQAB\n-----END PUBLIC KEY-----\n",
        "name": "Johnny Nguyen"
      }
    }
  ]
}