Skip to main content

ID Format Reference

All Pixieset API resources use consistent ID formats with specific prefixes to identify resource types.

Studio API ID Formats​

Resource TypePrefixExampleLength
Clientcl_cl_ABC123DEF456GHI789JKL012MNO34530 chars after prefix
Invoicein_in_INV001ABC123DEF456GHI789JKL01230 chars after prefix
Invoice Itemii_ii_ITM001ABC123DEF456GHI789JKL01230 chars after prefix
Paymentip_ip_PAY001ABC123DEF456GHI789JKL01230 chars after prefix
Couponcou_cou_COU001ABC123DEF456GHI789JKL0130 chars after prefix
Session Typeset_set_SES001ABC123DEF456GHI789JKL01230 chars after prefix
Sessionses_ses_SES002ABC123DEF456GHI789JKL0130 chars after prefix
Schedulesch_sch_SCH001ABC123DEF456GHI789JKL01230 chars after prefix
Schedule Intervalsa_sa_SCH002ABC123DEF456GHI789JKL01230 chars after prefix
Project Typeprt_prt_PRJ001ABC123DEF456GHI789JKL01230 chars after prefix
Contact Formcf_cf_CNT001ABC123DEF456GHI789JKL01230 chars after prefix
Contractco_co_CON001ABC123DEF456GHI789JKL01230 chars after prefix
Contract Templatect_ct_CON002ABC123DEF456GHI789JKL01230 chars after prefix
Questionnairequ_qu_QUE001ABC123DEF456GHI789JKL01230 chars after prefix
Questionnaire Templateqt_qt_QUE002ABC123DEF456GHI789JKL01230 chars after prefix
Quoteqo_qo_QUO001ABC123DEF456GHI789JKL01230 chars after prefix
Quote Templateqp_qp_QUO002ABC123DEF456GHI789JKL01230 chars after prefix
Email Templateet_et_EML001ABC123DEF456GHI789JKL01230 chars after prefix
Invoice Templateitp_itp_INV002ABC123DEF456GHI789JKL0130 chars after prefix
Google Calendar Settingsgs_gs_CAL001ABC123DEF456GHI789JKL01230 chars after prefix
User Manual Payment Methodump_ump_PAY002ABC123DEF456GHI789JKL0130 chars after prefix
Session Manual Payment Methodsmp_smp_PAY003ABC123DEF456GHI789JKL0130 chars after prefix
User Image Assetui_ui_IMG001ABC123DEF456GHI789JKL01230 chars after prefix
Gift Cardgc_gc_GFT001ABC123DEF456GHI789JKL01230 chars after prefix
Resource TypePrefixExampleLength
Collection-90516387Numeric, 8 digits
Gallery-129003127Numeric, 9 digits
Photo-Numeric IDVariable
Conversation-examplestudio_abc123def456Username + underscore + ID

ID Format Patterns​

Alphanumeric IDs (Studio API)​

Most Studio API resources use a consistent pattern:

  • Prefix: 2-4 lowercase letters followed by underscore
  • Identifier: 30 alphanumeric characters (mix of uppercase, lowercase, and numbers)
  • Total Length: Prefix length + underscore + 30 characters

Example breakdown:

cl_ABC123DEF456GHI789JKL012MNO345
│  │
│  └─ 30 character unique identifier
└─ Resource type prefix

Gallery API primarily uses numeric IDs:

  • Collections: 8-digit numbers
  • Galleries: 9-digit numbers
  • No prefixes for most resources

Special Format: Conversations​

Conversations in Gallery API use a compound format:

{username}_{unique_id}

Example: examplestudio_abc123def456

Usage in API Calls​

Path Parameters​

IDs are used in URL paths:

GET /clients/{client_id}
GET /collections/{collection_id}

Query Parameters​

IDs used for filtering:

GET /conversations/?client_id=cl_XYZ789DEF456GHI123JKL456MNO789

Request Bodies​

IDs referenced in POST/PUT requests:

{
  "client_id": "cl_ABC123DEF456GHI789JKL012MNO345",
  "session_type_id": "set_SES001ABC123DEF456GHI789JKL012"
}

Validation Tips​

  1. Check prefix: Ensure the ID starts with the correct prefix for the resource type
  2. Verify length: Most Studio API IDs have exactly 30 characters after the prefix
  3. Case sensitivity: IDs are case-sensitive - preserve exact casing
  4. No modification: Never modify or truncate IDs
  5. Store as strings: Always store IDs as strings, even numeric ones

Common Errors​

Invalid ID Format​

{
  "error": "Invalid client ID format",
  "message": "Client ID must start with 'cl_' prefix"
}

Resource Not Found​

{
  "error": "Resource not found",
  "message": "No client found with ID: cl_InvalidID123"
}

Best Practices​

  1. Validate IDs client-side before making API calls
  2. Store IDs unchanged from API responses
  3. Use constants for ID prefixes in your code
  4. Implement ID validation functions for each resource type
  5. Handle ID-related errors gracefully in your application