API Reference

The user object

Core user attributes

The following attributes are included in the urn:ietf:params:scim:schemas:core:2.0:Userschema

User Attributes urn:ietf:params:scim:schemas:core:2.0:User
id string
The unique ID of the Marq user that can be used to reference in many of Marq's REST API endpoints.
name object
Name of user that can be utilized for user smart fields. The following attributes are contained in the name object:

- formatted is a string of the full name of the user that will populate for the "full name" user smart field.
- givenName is a string of the full name of the user that will populate for the "first name" user smart field..
- familyName is a string of the full name of the user that will populate for the "last name" user smart field.
Example:
{ "name": { "formatted": "Sarah Anderson", "givenName": "Sarah", "familyName": "Anderson" } }
userName string
The user's username (usually their email).
displayName string
The name that is displayed and represents the user (usually their email).
canEdit boolean
Another indicator on whether the user can edit (has a Marq license). It is recommended to use the hasLicense parameter in the marq:1.0:User schema to grant or revoke a user's license.
active boolean
User's access status (whether a user can log into Marq platform).
roles array
roles
Billing Admin, Team Admin, Template Admin, Print Approver, Document Approver, Data Admin, Analytics User, Campaigns User
emails array of objects
Emails associated to the user that can be utilized for user smart fields. The following attributes are contained in an email object:

- value is an email address associated to the user
-primary is a boolean to indicate if the email is the primary/default email for the user.Example:
"emails": [ { "value": "[email protected]", "primary": true } ]

Marq user attributes

The following attributes are included in the urn:ietf:params:scim:schemas:extension:marq:1.0:Userschema

Marq User Attributes urn:ietf:params:scim:schemas:extension:marq:1.0:User
billingCode string
Billing codes can be added to a user for certain printer orders to allow printers to appropriately assign costs to a specific cost center for the organization.
hasLicense boolean
Allows you assign a Marq license that allows the user to create projects and make edits within Marq's editor. If a user has a license set to false they will become a view only user with limited permissions to the Marq platform.
officeIdAtPrintVendor string
Can be used to pass through to a print partner the associated external ID of an office or organization that the user is a member.
userIdAtPrintVendor string
Can be used to pass through to a print partner the associated external ID of the user for the designated printer.
primaryGroup integer
When creating a user, or updating a user you may use the primaryGroup attribute to automatically assign a user to a group and designate the group as their primary group. Primary groups can be used to restrict sharing and access to other users within Marq.

Custom user fields

The following attributes are included in the urn:ietf:params:scim:schemas:extension:lucidpress:1.0:UserFields schema

Custom User Field Attributes urn:ietf:params:scim:schemas:extension:lucidpress:1.0:UserFields
fullName string
The user attribute that will populate the Full Name smart field in templates. Typically the combination of the first and last name of the user (e.g. Mary Smith)
middleName string
The user attribute that will populate the Middle Name smart field in templates.
preferredName string
The user attribute that will populate the Preferred Name smart field in templates.
title string
The user attribute that will populate the Title smart field in templates.
address string
The user attribute that will populate the Address smart field in templates.
homeOffice string
The user attribute that will populate the Home Office smart field in templates.
workPhone string
The user attribute that will populate the Work Phone smart field in templates.
cellPhone string
The user attribute that will populate the Cell Phone smart field in templates.
company string
The user attribute that will populate the Company smart field in templates.
website string
The user attribute that will populate the Website smart field in templates.
agentNumber string
For Marq client that are in the Real Estate industry, a special user attribute is available for users. This can be used to auto populate the License Number smart field within templates, and will also filter properties within a data automation so that an agent can only see properties they are assigned (admins will need to activate the "data restriction" option in the data atuomation configuration.
profileImage string
Must be Image URL The primary image URL of the user that can be auto populated within templates and projects when a Marq smart field exists. Users may have multiple profile images that can be added by adding and underscore and number. Multiple profile images will allow the user to swap the default profile image in a template or project with a different profile image.

Example:
"profileImage": "https://images.abc.com/xyz", "profileImage_1": "https://images.abc.com/123"
secondaryProfileImage string
Must be Image URL Similar to the profileImage but can be used as a distinctly separate placeholder in templates for a different set of profile images. Examples of when to use a secondary profile image include a profile image that has a transparent background, or a team/office group image. Can also have multiple images by adding a suffix of the underscore and number to the attribute.

Example:
"secondaryProfileImage": "https://images.abc.com/qwerty", "secondaryProfileImage_1": "https://images.abc.com/789"
tertiaryProfileImage string
Must be Image URL Similar to the profileImageand secondaryProfileImageas an additional option for smart field images.

Example:
"tertiaryProfileImage": "https://images.abc.com/qwerty", "tertiaryyProfileImage_1": "https://images.abc.com/789"
logo string
Must be Image URL The personal logo image URL of the user that can be auto populated within templates and projects when a Marq smart field exists. Users may have multiple logos that can be added by adding and underscore and number. Multiple logos will allow the user to swap the default personal logo image in a template or project with a different logo image.

Example:
"logo": "https://images.abc.com/logo/111", "logo_1": "https://images.abc.com/logo/222"
secondaryLogo string
Must be Image URL Similar to the logo smart field image but can be used as a distinctly separate placeholder in templates for a different set of logos (e.g. secondaryLogo images are used for "Horizontal Stacked" logos).

Example:
"logo": "https://images.abc.com/logo/333", "logo_1": "https://images.abc.com/logo/444"
tertiaryLogo string
Must be Image URL similar to both logo and secondaryLogo images, but provides a third option of personal logo types that can be used for designated placeholders.

Example:
"logo": "https://images.abc.com/logo/555", "logo_1": "https://images.abc.com/logo/666"
--- Additional Custom Fields and Values --
You can include any additional key, value pairs that will be added as custom user smart fields. Often clients will add personal links for social media sites of the user, or add specific disclaimers based on the user's role, geolocation, etc.

User object example

{
    "name": {
        "formatted": "Mary Jane Smith",
        "givenName": "Mary",
        "familyName": "Smith"
    },
    "displayName": "[email protected]",
    "userName": "[email protected]",
    "canEdit": true,
    "active": true,
    "emails": [
        {
            "value": "[email protected]",
            "primary": true
        }
    ],
    "roles": [
        "Billing Admin",
        "Team Admin",
        "Template Admin",
        "Print Approver",
        "Document Approver",
        "Data Admin",
        "Analytics User",
        "Campaigns User"
    ],
    "urn:ietf:params:scim:schemas:extension:lucidpress:1.0:UserFields": {
        "address": "123 Main Street",
        "fullName": "Mary Jane Smith",
        "middleName": "Jane",
        "preferredName": "MJ",
        "website": "www.mjsmith.com",
        "homeOffice": "801-358-2385",
        "workPhone": "222-222-2222",
        "cellPhone": "111-111-1111",
        "title": "Director of Sales",
        "agentNumber": "123",
        "company": "Elevated Sights",
        "profileImage": "https://images.app.marq.com/images/1e62a591-ee17-4541-a10b-2cbb4023142e?product=press",
        "profileImage_1": "https://images.app.marq.com/images/35b149fd-e75c-4536-8cda-38ee34fdf3ee?product=press",
        "secondaryProfileImage": "https://images.app.marq.com/images/369d9539-51ee-4ec6-a92a-b40fb340c0c7?product=press",
        "secondaryProfileImage_1": "https://images.app.marq.com/images/5f5288ab-3510-4b69-a5b6-172f50c01b04?product=press",
        "tertiaryProfileImage": "https://images.app.marq.com/images/c7f890a9-25b8-4e3a-a932-a1035488eb56?product=press",
        "logo": "https://images.app.marq.com/images/b2da389a-344a-4d92-9b64-eb9ff77a4f07?product=press",
        "logo_1": "https://images.app.marq.com/images/f0322fc5-19f6-4215-9baa-88fac597603d?product=press",
        "secondaryLogo": "https://images.app.marq.com/images/6bc7e7bb-45b4-47b7-896c-9d6a08ac265a?product=press",
        "secondaryLogo_1": "https://images.app.marq.com/images/a061b47c-9216-46ee-9a89-69d5781f1fa0?product=press",
        "secondaryLogo_2": "https://images.app.marq.com/images/d43b498d-9340-4c12-8732-0434cfef7344?product=press",
        "secondaryLogo_3": "https://images.app.marq.com/images/ac98d8e9-b00d-40d5-815a-c2e40e8ec548?product=press",
        "secondaryLogo_4": "https://images.app.marq.com/images/f85bfa54-da43-4dd2-a455-5d57705599e0?product=press",
        "tertiaryLogo": "https://images.app.marq.com/images/5a052dc0-d7d0-4055-b014-3d3f4592ad95?product=press",
        "tertiaryLogo_1": "https://images.app.marq.com/images/7d620106-e8bf-4990-be9e-4d15c13263fc?product=press",
        "Facebook URL": "www.facebook.com/bmoss",
        "Twitter URL": "www.x.com/bmoss",
        "LinkedIn URL": "www.linkedin.com/bmoss",
        "Role Description": "Lead Consultant: Team and client lead for strategic and technical direction, and ongoing client relations manager",
        "Legal Language": "\"We do not offer every plan available in your area. Please contact Medicare.gov, 1-800-MEDICARE, or your local State Health Insurance Program (SHIP) to get information on all of your options.\""
    },
    "urn:ietf:params:scim:schemas:extension:marq:1.0:User": {
        "billingCode": "123",
        "hasLicense": true,
        "officeIdAtPrintVendor": "203940a",
        "userIdAtPrintVendor": "2423",
        "primaryGroup": 120934,
    },
    "urn:ietf:params:scim:schemas:extension:lucidchart:1.0:User": {
        "canEdit": true,
        "addOns": []
    },
    "urn:lucidchart:schemas:1.0:User": {
        "canEdit": true,
        "addOns": []
    },
    "urn:ietf:params:scim:schemas:extension:lucid:1.0:User": {
        "billingCode": "123",
        "productLicenses": {
            "Marq": true
        },
        "officeIdAtPrintVendor": "203940a",
        "userIdAtPrintVendor": "2423",
        "primaryGroup": 120934,
    },
    "urn:ietf:params:scim:schemas:extension:lucid:2.0:User": {
        "billingCode": "123",
        "officeIdAtPrintVendor": "203940a",
        "userIdAtPrintVendor": "2423",
        "primaryGroup": 120934,
        "productLicenses": {
            "Marq": true
        }
    },
    "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User",
        "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
        "urn:lucidchart:schemas:1.0:User",
        "urn:ietf:params:scim:schemas:extension:lucidchart:1.0:User",
        "urn:ietf:params:scim:schemas:extension:lucid:1.0:User",
        "urn:ietf:params:scim:schemas:extension:lucid:2.0:User",
        "urn:ietf:params:scim:schemas:extension:marq:1.0:User"
    ],
    "meta": {
        "resourceType": "User",
        "created": "2024-04-11T05:26:01Z",
        "lastModified": "2025-04-11T06:33:56Z",
        "version": "W/\"1744353236000\"",
        "location": "https://users.app.marq.com/scim/v2/press/Users/lucid-164182504"
    },
    "id": "lucid-164182504"
}