Display
GET /api/v2/{bucket}/{resource_type}/{uid}/display
GET
/api/v2/{bucket}/{resource_type}/{uid}/display
The display name for the record e.g. the persons name or the organisation name
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” bucket
required
The bucket (client) name
string
Example
example resource_type
required
The type of resource, usually the second element in the URI e.g person, organisation, member, payment
string
Example
person uid
required
Usually the final element in the URI, an alphanumeric unique identifier
string
Example
6305f074683e800f3abe809eResponses
Section titled “ Responses ”The display name for the record
object
display_value
string
Example
Caroline SmithBad request, see the error field for details
Unauthorized is the status code to return when the client provides no credentials or invalid credentials.
Forbidden is the status code to return when a client has valid credentials but not enough privileges to perform an action on a resource.
Not found
An error occurred within sheepCRM, please report to support@sheepcrm.com