GET All Beef Cut Collections

Calls to this endpoint will return a list of all the beef cut collections that are available via the API.

The base URI for Get all beef cut collections is:

GET /api/v2/beefcut/collection

Get All Beef Cut Collections Parameters

Try This Endpoint on Swagger
Name Required Parameter Type Data Type
AuthorizationAppID (optional) query string
  This value must be present in either the http header or in the query string. If you supply an incorrect value or do not supply a value in the header or query string, then you will receive a http 401 error. (Please see Authentication section)
AuthorizationAppKey (optional) query string
  This value must be present in either the http header or in the query string. If you supply an incorrect value or do not supply a value in the header or query string, then you will receive a http 401 error. (Please see Authentication section)

What it Returns

Requests to the Get all beef cut collections will return the following data:

Name & Description Type
  • BeefAPICollectionList object
    A container that holds the list of available recipe collections
    • collectionListing array
      A list of beet cut collections that are available from the beefAPI.
    • collectionID int
      Unique identifier of the collection
    • collectionName string
      Name of the collection
    • collectionNameSlug string
      URL-friendly slugged name of the collection
    • collectionGroup object
      Contains information about the group to which the collection belongs. Object values found in this array will be an exact match to what can be found in the master list of collection groups in the common endpoint (/api/v2/common/lookups)
      • collectionGroupName string
        Name of the collection group
      • collectionGroupNameSlug string
        URL-friendly name of the collection group
      • objectType object
        The type object this collection group pertains to. Object values found in this array will be an exact match to what can be found in the master list of objectTypes in the common endpoint (/api/v2/common/lookups)
        • objectTypeName string
          The name of the object type this collection group pertains to
        • objectTypeNameSlug string
          URL-friendly slugged name of the object type this collection group pertains to
    • objectType object
      The type object this collection group pertains to. Object values found in this array will be an exact match to what can be found in the master list of objectTypes in the common endpoint (/api/v2/common/lookups)
      • objectTypeName string
        The name of the object type this collection group pertains to
      • objectTypeNameSlug string
        URL-friendly slugged name of the object type this collection group pertains to
    • links array
      A list of HATEOAS in relation to this collection. Typically if this collection is online, you will be provided with a link to the endpoint to get the full collection details.
      • rel string
        The rel attribute specifies the relationship between the current document and the linked document
      • href string
        URI of the beefapi call to get more information for this links' context
      • title string
        Title of the link