This endpoint returns a list of all genders held on the platform.  The returned list will be determined by the permissions/access of the API client.


GET    /api/static/genders/get



Authorization

The following authorization header is required.  The authorisation header should be set to a 'Bearer Token' type


Token
see How to get a bearer token



Response

The response will return an array of 0 to n JSON objects.  Each JSON object in the array contains the following properties:


idintthe internal system id of the gender
namestringthe textual name of the gender


Permissions

The API Client requires read access to the platform.


Examples


C# Example


var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://{platform API url}/api/static/genders/get";
request.Headers.Add("Authorization", "Bearer {access token}");
var response = await client.SendAsync(request); response.EnsureSuccessStatusCode(); Console.WriteLine(await response.Content.ReadAsStringAsync());


cURL Example


curl --location 'https://{platform API url}/api/static/genders/get' \ --header 'Authorization: Bearer {access token}'