Skip to main content

API Integration

Property Matrix provides a GraphQL API that your software developers can use to integrate Property Matrix data with other applications. The API uses OAuth2 authentication.

Written by Conor Taliancich

Steps for accessing the Property Matrix API:

  1. In Property Matrix, click on your profile in the bottom left of the screen and select Settings > API.

  2. Under API Applications, select + New Application.
    ​

  3. Enter the application details:

    • Application Name: a name for your integration.

    • Allowed Origin: the browser origin allowed for CORS requests, such as https://app.example.com. Include only the scheme, host, and optional port.

    • Redirect URI: the OAuth callback URL hosted by your application, such as https://app.example.com/oauth/callback.
      ​

  4. Select Create Application. Save the Client ID and Client Secret immediately. For security, the client secret is only shown once after the application is created.

  5. While signed in as an admin for the Property Matrix account, open the OAuth authorization URL in your browser after replacing CLIENT_ID and REDIRECT_URI with your values: https://app.propertymatrix.com/oauth/authorize?response_type=code&client_id=CLIENT_ID&redirect_uri=REDIRECT_URI

  6. Authorize the application. Property Matrix will redirect back to your Redirect URI with a code parameter. Save that code.

  7. You can now make a request to get an access token. If your previous access token has not expired yet, you will not be able to request a new token, and you will get a 401 error if you attempt to do so. To request an access token, make a HTTP post request with a 'Content-Type' of 'Application/JSON' to https://app.propertymatrix.com/oauth/token with the following parameters:

    1. grant_type: a hard-coded string value for "authorization_code" - this value will not change

    2. redirect_uri: the same URL you provided us at the start

    3. client_id: your OAuth client id

    4. client_secret: your OAuth secret code: your OAuth code from the redirect URL

  8. If the HTTP post request succeeds, you will get back a JSON object with the following keys:

    1. "access_token": the authorization token you will use

    2. "token_type": "Bearer"

    3. "expires_in": the number of seconds before the token expires

    4. "created_at": integer value for the time the token was created

  9. If you run into any errors, you can check the response status and message to see the failure reason.

You can now use the access token to make API calls to https://www.propertymatrix.com/graphql_api . Sample queries can be viewed and tested in Property Matrix on the settings page > API.
​

Your software developers can then use the data from the Property Matrix API to integrate with other software.

Did this answer your question?