Skip to main content
POST
/
v3
/
profiles
/
fetch
Fetch profiles with corresponding data
curl --request POST \
  --url https://bee.theswarm.com/v3/profiles/fetch \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "linkedin_names": [
    "<string>"
  ],
  "linkedin_ids": [
    123
  ],
  "linkedin_entity_ids": [
    "<string>"
  ],
  "fields": [
    "profile_info"
  ]
}
'
{
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "lists": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "status": "<string>"
        }
      ],
      "tags": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>"
        }
      ],
      "profile_info": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "full_name": "<string>",
        "first_name": "<string>",
        "last_name": "<string>",
        "headline": "<string>",
        "about": "<string>",
        "linkedin_url": "<string>",
        "work_email": "<string>",
        "personal_emails": [
          "<string>"
        ],
        "current_title": "<string>",
        "current_function": "<string>",
        "current_seniorities": [
          "<string>"
        ],
        "current_company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "current_company_name": "<string>",
        "current_company_logo_url": "<string>",
        "current_company_size": {
          "min": 123,
          "max": 123
        },
        "current_company_location": "<string>",
        "current_company_linkedin_url": "<string>",
        "experience": [
          {
            "is_current": true,
            "company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "company": {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "canonical_name": "<string>",
              "name": "<string>",
              "founded": "2023-11-07T05:31:56Z",
              "size": {
                "min": 123,
                "max": 123
              },
              "social_media": [
                {
                  "network": "<string>",
                  "id": "<string>",
                  "slug": "<string>",
                  "url": "<string>"
                }
              ],
              "locations": [
                {
                  "name": "<string>",
                  "city": "<string>",
                  "state": "<string>",
                  "country": "<string>",
                  "is_primary": true
                }
              ],
              "industries": [
                "<string>"
              ],
              "websites": [
                "<string>"
              ],
              "logo_url": "<string>"
            },
            "title": "<string>",
            "seniorities": [
              "<string>"
            ],
            "function": "<string>",
            "location": [
              "<string>"
            ],
            "description": "<string>",
            "start_date": "2023-12-25",
            "end_date": "2023-12-25"
          }
        ],
        "current_location": "<string>",
        "location_locality": "<string>",
        "location_region": "<string>",
        "location_country": "<string>",
        "location_continent": "<string>",
        "skills": [
          "<string>"
        ],
        "education": [
          {
            "school": {
              "name": "<string>",
              "location": {
                "name": "<string>",
                "city": "<string>",
                "state": "<string>",
                "country": "<string>"
              },
              "website": "<string>",
              "linkedin_url": "<string>",
              "linkedin_id": 123
            },
            "start_date": "2023-12-25",
            "end_date": "2023-12-25",
            "degrees": [
              "<string>"
            ],
            "majors": [
              "<string>"
            ],
            "activities": "<string>",
            "grade": "<string>",
            "description": "<string>"
          }
        ],
        "social_media": [
          {
            "network": "<string>",
            "id": "<string>",
            "entity_id": "<string>",
            "url": "<string>",
            "connections": 123,
            "followers": 123,
            "slug": "<string>",
            "join_date": "<string>"
          }
        ],
        "smart_tags": [
          "<string>"
        ],
        "latest_role_change_at": "2023-12-25",
        "latest_company_change_at": "2023-12-25",
        "current_job_updated_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "created_at": "2023-11-07T05:31:56Z",
        "last_refresh_at": "2023-11-07T05:31:56Z",
        "current_company_websites": [
          "<string>"
        ],
        "current_company_industries": [
          "<string>"
        ],
        "certifications": [
          {
            "end_date": "<string>",
            "name": "<string>",
            "organization": "<string>",
            "start_date": "<string>"
          }
        ],
        "image_url": "<string>",
        "hiring": true,
        "open_to_work": true
      },
      "found_by": {
        "ids": [
          "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        ],
        "linkedin_names": [
          "<string>"
        ],
        "linkedin_ids": [
          123
        ],
        "linkedin_entity_ids": [
          "<string>"
        ]
      }
    }
  ],
  "not_found": [
    "<string>"
  ]
}
The Fetch Profile endpoint retrieves specific profiles based on their unique identifiers (profile IDs or LinkedIn usernames). The fields array accepts the following values:
  • tags β€” Tags assigned to the profile.
  • lists β€” Lists the profile is assigned to.
  • profile_info β€” Detailed profile data (work experience, education, etc.).
For request examples, see Fetch endpoint examples. For the full response schema, see Models > Profile.

Limits

Each identifier array (ids, linkedin_usernames, linkedin_ids, linkedin_entity_ids) accepts up to 1,000 values per request. Combine arrays freely up to the per-array cap.

Responses

In addition to the standard error responses, this endpoint may return:
  • 402 Payment Required β€” your team’s API credit allowance has been exceeded. Top up or upgrade your plan to continue. See Credits & Usage.
Migrating from v2? v3 uses snake_case for all field names. The v2 equivalents were linkedinNames, linkedinIds, linkedinEntityIds, and notFound. See the Migrating to v3 guide.

Authorizations

x-api-key
string
header
required

Body

application/json
ids
string<uuid>[]
required

The Swarm profile IDs

Maximum array length: 1000
linkedin_names
string[]

LinkedIn profile URL slugs

Maximum array length: 1000
linkedin_ids
integer[]

LinkedIn numeric profile IDs

Maximum array length: 1000
linkedin_entity_ids
string[]

LinkedIn alphanumeric entity IDs

Maximum array length: 1000
fields
enum<string>[]
Available options:
profile_info,
tags,
lists

Response

A list of profiles with corresponding data

results
object[]
required

List of profiles with corresponding data

not_found
string[]

Identifiers (ids / linkedin_names / linkedin_ids / linkedin_entity_ids) not found