pub.chive.actor.getProfileConfig

chive.pub

Documentation

Get profile configuration for a user

main query

Get profile configuration for a user

Parameters

did string Required

DID of the user

Output

Encodingapplication/json
did string Required

DID of the user

featuredCollectionUri string Optional

AT-URI of the featured collection

profileType string Required

Profile type identifier

sections array Required

Profile display sections

uri string Optional

AT-URI of the profile config record

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
DID of the user
View raw schema 
{
  "type": "query",
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "did",
        "profileType",
        "sections"
      ],
      "properties": {
        "did": {
          "type": "string",
          "description": "DID of the user"
        },
        "uri": {
          "type": "string",
          "description": "AT-URI of the profile config record"
        },
        "sections": {
          "type": "array",
          "items": {
            "ref": "#profileSectionView",
            "type": "ref"
          },
          "description": "Profile display sections"
        },
        "profileType": {
          "type": "string",
          "description": "Profile type identifier"
        },
        "featuredCollectionUri": {
          "type": "string",
          "description": "AT-URI of the featured collection"
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "did"
    ],
    "properties": {
      "did": {
        "type": "string",
        "description": "DID of the user"
      }
    }
  },
  "description": "Get profile configuration for a user"
}
profileSectionView object

Configuration for a profile display section

Properties

order integer Required

Display order of the section

type string Required

Section type identifier

visible boolean Required

Whether the section is visible

View raw schema 
{
  "type": "object",
  "required": [
    "type",
    "visible",
    "order"
  ],
  "properties": {
    "type": {
      "type": "string",
      "description": "Section type identifier"
    },
    "order": {
      "type": "integer",
      "description": "Display order of the section"
    },
    "config": {
      "ref": "#sectionConfig",
      "type": "ref",
      "description": "Section-specific configuration"
    },
    "visible": {
      "type": "boolean",
      "description": "Whether the section is visible"
    }
  },
  "description": "Configuration for a profile display section"
}
sectionConfig object

Section-specific display configuration. Properties vary by section type.

Properties

collectionUri string Optional

AT-URI of a collection to feature

maxItems integer Optional

Maximum number of items to display

sortBy string Optional

Sort order for section items

View raw schema 
{
  "type": "object",
  "properties": {
    "sortBy": {
      "type": "string",
      "description": "Sort order for section items"
    },
    "maxItems": {
      "type": "integer",
      "description": "Maximum number of items to display"
    },
    "collectionUri": {
      "type": "string",
      "description": "AT-URI of a collection to feature"
    }
  },
  "description": "Section-specific display configuration. Properties vary by section type."
}

Lexicon Garden

@