Get a page of FAF profiles

​

Query Parameters

  • PageIndex
    Type: integerFormat: int32

    The page index of the search.

  • PageSize
    Type: integerFormat: int32

    The number of items to be returned in the response. Returns pages of up to 500 records.

  • SearchText
    Type: string

    The search text to filter FAF profiles by name.

  • Status
    Type: enum

    The profile status filter.

Responses

  • application/json
Request Example for get/v1/faf-profiles
curl 'https://api.consignlyhq.com/v1/faf-profiles?PageIndex=0&PageSize=25&SearchText=Domestic&Status=1'

{
  "index": 1,
  "total": 1,
  "fafProfiles": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": null,
      "status": "enum (Active = 1, Inactive = 2)"
    }
  ]
}

OK