Contents

Get Blueprints

Get a list of Blueprints in an organization.

URL

GET https://api-business.apple.com/v1/blueprints

Query Parameters

NameTypeDescription
fields[blueprints] Optional[string]

The fields to return for included related types.

limit Optionalinteger

The number of resources to return (maximum 1000).

include Optional[string]

Related resources to include in the response. Possible values: apps, configurations, packages, orgDevices, users, userGroups.

limit[apps] Optionalinteger

Maximum number of related apps to include.

limit[configurations] Optionalinteger

Maximum number of related configurations to include.

limit[packages] Optionalinteger

Maximum number of related packages to include.

limit[orgDevices] Optionalinteger

Maximum number of related devices to include.

limit[users] Optionalinteger

Maximum number of related users to include.

limit[userGroups] Optionalinteger

Maximum number of related user groups to include.

Response Codes

StatusReasonTypeDescription
200OK
Content-Type: application/json
BlueprintsResponse

400Bad Request
Content-Type: application/json
ErrorResponse

An error occurred with your request.

401Unauthorized
Content-Type: application/json
ErrorResponse

403Forbidden
Content-Type: application/json
ErrorResponse

Request not authorized.

429
Content-Type: application/json
ErrorResponse

Too Many Requests

Topics

Responses

See Also

Blueprints