Skip to content

Terminology

TermDefinition
api_keyThe bearer token provided by the auth call. Must be supplied as an Authorization header for all authenticated calls.
flockThe client identifier / database, also known as a bucket.
resource_typeThe data type, table, or model used by Sheep. Examples: person, organisation, booking, ticket, payment.
resourceA single record of a given resource type.
primary resourcesperson, organisation, booking, group
secondary resourcesRecords which attach to primary resources, e.g. payment, ticket, membership.
sheep uriSheep URIs are used extensively to refer to resources. They are composed as /$FLOCK/{resource_type}/{uid}/.
slugified uriA Sheep URI expressed as a flat string: $FLOCK-{resource_type}-{uid}.