Using External IDs

External IDs are used when documents are imported from or reference a related document in another platform. These could be documents that have been migrated from a previous system, created from integrations, or reference documents in other internal systems.

For more information on what External IDs are please consult https://docs.bipsync.com/docs/api-working-with-external-ids#/.

When using GraphQL external IDs can be retrieved using their source name.

For example this query displays the ID of funds from a third party:

{
  funds {
    edges {
      node {
        id
        name
        externalIds {
          burgiss
        }
      }
    }
  }
}

{
  "data": {
    "projects": {
      "edges": [
        {
          "node": {
            "id": "68b993fa85d14160d4030391",
            "name": "Klein-Kiehn",
            "externalIds": {
              "burgiss": [
                "123456790"
              ]
            }
          }
        },
        {
          "node": {
            "id": "68b993fa85d14160d4030394",
            "name": "Marks-Kihn",
            "externalIds": {
              "burgiss": []
            }
          }
        },
        ...
      ]
    }
  }
}

N.B Note that when properties are not set on a document, these will appear as null or as an empty list [].